home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWTPtrHashDictionaryIterator.z / RWTPtrHashDictionaryIterator
Encoding:
Text File  |  2002-10-03  |  5.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))          RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWTPtrHashDictionaryIterator<K,V> - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/tphdict.h>
  13.  
  14.  
  15.  
  16.               unsigned hashFun(const K&);
  17.           RWTPtrHashDictionary<K,V> dictionary(hashFun);
  18.           RWTPtrHashDictionaryIterator<K,V> iterator(dictionary);
  19.  
  20. PPPPlllleeeeaaaasssseeee NNNNooootttteeee!!!!
  21.      IIIIffff yyyyoooouuuu ddddoooo nnnnooootttt hhhhaaaavvvveeee tttthhhheeee SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ddddeeeessssccccrrrriiiibbbbeeeedddd
  22.      hhhheeeerrrreeee....  OOOOtttthhhheeeerrrrwwwwiiiisssseeee,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ttttoooo RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr described in
  23.      the Class Reference.
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  31.      Iterator for class RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy<<<<KKKK,,,,VVVV>>>> allowing sequential access
  32.      to all keys and values of a parameterized hash dictionary.  Elements are
  33.      not accessed in any particular order.  Like all Rogue Wave iterators, the
  34.      "current item" is undefined immediately after construction -- you must
  35.      define it by using ooooppppeeeerrrraaaattttoooorrrr(((()))) or some other (valid) operation.  Once the
  36.      iterator has advanced beyond the end of the collection it is no longer
  37.      valid -- continuing to use it will bring undefined results.
  38.  
  39. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  40.      None
  41.  
  42. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  43.               RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr(RWTPtrHashDictionary& c);
  44.  
  45.  
  46.      Constructs an iterator to be used with the dictionary cccc.
  47.  
  48.  
  49.  
  50.  
  51.  
  52. PPPPuuuubbbblllliiiicccc OOOOppppeeeerrrraaaattttoooorrrrssss
  53.               RWBoolean
  54.           ooooppppeeeerrrraaaattttoooorrrr++++++++();
  55.  
  56.  
  57.      Advances the iterator to the next key-value pair and returns TTTTRRRRUUUUEEEE.  When
  58.      the end of the collection is reached, returns FFFFAAAALLLLSSSSEEEE and the position of
  59.      the iterator will be undefined.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))          RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.               K*
  75.           ooooppppeeeerrrraaaattttoooorrrr(((())))();
  76.  
  77.  
  78.      Advances the iterator to the next key-value pair and returns a pointer to
  79.      the key.  When the end of the collection is reached, returns nnnniiiillll and the
  80.      position of the iterator will be undefined.  Use member function vvvvaaaalllluuuueeee(((())))
  81.      to recover the dictionary value.
  82.  
  83. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  84.               RWTPtrHashDictionary*
  85.           ccccoooonnnnttttaaaaiiiinnnneeeerrrr() const;
  86.  
  87.  
  88.      Returns a pointer to the collection over which this iterator is
  89.      iterating.
  90.  
  91.               K*
  92.           kkkkeeeeyyyy() const;
  93.  
  94.  
  95.      Returns a pointer to the key at the iterator's current position.  The
  96.      results are undefined if the iterator is no longer valid.
  97.  
  98.               void
  99.           rrrreeeesssseeeetttt();
  100.  
  101.  
  102.      Resets the iterator to the state it had immediately after construction.
  103.  
  104.               void
  105.           rrrreeeesssseeeetttt(RWTPtrHashDictionary& c);
  106.  
  107.  
  108.      Resets the iterator to iterate over the collection cccc.
  109.  
  110.               V*
  111.           vvvvaaaalllluuuueeee() const;
  112.  
  113.  
  114.      Returns a pointer to the value at the iterator's current position.  The
  115.      results are undefined if the iterator is no longer valid.
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.